home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / text / man379.lha / doc / man.doc < prev    next >
Encoding:
Text File  |  1995-02-04  |  2.3 KB  |  78 lines
  1.  
  2. ; The mandoc file for MAN's man page...
  3. ; take a look at the format of this file; it's pretty simple.
  4. ;
  5. ; doc2man will automatically recognize the section headers as long as they are
  6. ; a) on a line of their own, b) all in uppercase and c) terminated with a
  7. ; colon.
  8. ;
  9. ; the following chars must be escaped with a backslash: \ { } _ |
  10. ;
  11. ; enclose text with the following to apply these styles:
  12. ;    {italics} _underline_ |bold|
  13. ;
  14. ; you can comment out lines with a ';' at the START of file only.  The
  15. ; first real line must be of the format "filename(section) - optional text",
  16. ; where filename is the manpage name and section is one of the following:
  17. ;    1 = user commands    5 = file formats
  18. ;    2 = system kernel funcs    6 = games and demos
  19. ;    3 = c library funcs    7 = environments and tables
  20. ;    4 = device interfaces    8 = maint commands
  21. ;
  22. ; any questions?  just mail aw785@freenet.carleton.ca   ...good luck!
  23. ;
  24. ; Fri Feb 03 23:48:24 1995
  25.  
  26. man(1) - user cmds
  27.  
  28. NAME:
  29.  
  30. man - the manual pager (37.9, Feb/95)
  31.  
  32. SYNOPSIS:
  33.  
  34. man [section] item [output]
  35.  
  36. DESCRIPTION:
  37.  
  38. man formats system manual pages for reference, making use of the
  39. system {more} utility to page them to the standard output for
  40. display.
  41.  
  42. The _item_ paramater is mandatory; it specifies the function or
  43. command name to look up. _section_ is an optional manual section
  44. under which to look (currently, following the de facto UNIX
  45. ordering). Any filename passed to _output_ will receive the
  46. formatted man pages instead of the {more} command.
  47.  
  48. man checks the environment variable |console\_width| for the
  49. horizontal size of your display or printer.  The variable can be
  50. either local or global.  If it is unset, a default value of 74 is
  51. assumed (visually balanced with the 6-col margin on an 80-col
  52. display).
  53.  
  54. man will also compare datestamps on the cat and man files, and if the
  55. man file is newer than the existing cat file it will be reformatted.
  56. Else, the cat file will be paged.  This is to save time in unnecessarily
  57. reformatting long files.
  58.  
  59. More specific documentation is pending.
  60.  
  61. OPTIONS:
  62.  
  63. None at present.
  64.  
  65. FILES:
  66.  
  67. man:manX/foo.X - manual page file, where X is a section num and foo
  68. is a name.
  69.  
  70. t:manual/foo.X - formatted version of same, cached to expediate redisplay
  71.  
  72. man:whatis - the whatis database for keyword search (not yet implemented).
  73.  
  74. SEE ALSO:
  75.  
  76. {man2doc}, {doc2man}, {guide2man}, {more}, {setenv}
  77.  
  78.